Retrieves low-level events stored in the Operating System event queue.

Boolean GetOSEvent (
    EventMask mask, 
    EventRecord *theEvent
);

Parameter descriptions

mask

A value that indicates which kinds of events are to be returned; this parameter is interpreted as a sum of event mask constants. You specify the event mask using one or more values defined by “EventMask Constant”. GetOSEvent returns only low-level events stored in the Operating System event queue; it does not return activate, update, operating-system, or high-level events. If no low-level event of any of the designated kinds is available, GetOSEvent returns a null event.

theEvent

A pointer to an event structure for the next available low-level event of the specified type or types in the Operating System event queue. The GetOSEvent function removes the returned event from the Operating System event queue and returns the information about the event in an event structure. The event structure includes the type of event received and other information.

DISCUSSION

In most cases, your application should not use this function. The GetOSEvent function retrieves and removes an event from the Operating System event queue. GetOSEvent returns false as its function result if the event being returned is a null event; otherwise, GetOSEvent returns true. GetOSEvent does not intercept or respond to the event in any way. It also does not process Command–Shift– number key combinations or process any alarms set by the user through the Alarm Clock desk accessory.

AVAILABILITY

Not supported in Carbon. Not available in Carbon.

CARBON NOTES

GetOSEvent is not supported in Carbon. Use the GetNextEvent function instead.

© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)